今天的文章不是一個技術文,反而是探討身為一個軟體工程師,該怎麼撰寫相關的技術文件
鑑於 WFH (Work From Hoem) 習慣的興起,人與人面對面的溝通減少,這意味即時的訊息傳遞變少了,取而代之的是非同步的訊息傳遞,簡單來說就是技術文件。
好的技術文件能夠讓需要的人快速找到問題,解決疑惑,但是一個好的技術文件到底該怎麼寫,這部分其實非常困難,並不是向程式碼一樣可以 copy&paste 馬上看到成果的,反而是需要時間練習,將整個過程與思路消化起來,用自己習慣的語言與形式將其撰寫出來。
首先,作者非常推崇由 Google 撰寫的系列文章,Tech Writing Course,整個課程內容不到兩小時,從不同章節來跟大家分享如何撰寫技術文章
接者撰寫技術文章時,作者個人是喜歡 divio 這個平台,不過更重要的則是其推薦的分類模式,根據內容分類成四大項
1. Tutorials - 學習導向
2. How-To Guides - 問題解決導向
3. Explanation - 深度理解導向
4. Reference - 資運分享導向
Google: https://developers.google.com/tech-writing
Divio: https://www.divio.com/
最後寫作語法方面,作者認為寫出一個能夠被有效搜尋的文章是非常重要的,譬如透過 word 等方式上傳檔案到系統中反而是一個不利於搜尋的方式。
取而代之的是,作者認為可以採用 Markdown 類似的語法作為基礎去撰寫文章,這種方式對於維護與撰寫都相對容易
今天有任何 Diagrams 的畫圖需求,可以考慮使用 Mermaid 這套解決方案,對於 GitLab/Azure 的使用者來說,已經內建其中。 GitHub/Atlassian Confluence 則有相關的 Plugin 可以安裝使用
最後則是文章的樣版內容,針對特定的文章格式,已經有不少的範本可以參考,透過這些範本可以更清楚的去描述你的內容,讓整體文章看起來更佳簡潔與流暢
1. Software Architecture Review Template
2. Architecture Decision Record Template
3. Incident Postmortem Template
4. DevOps Runbook
5. Decision Template
6. Writing Guidelines
7. OKR Template
8. Etc.
有興趣的點選原文學習更多
https://medium.com/better-programming/best-practices-when-documenting-your-code-for-software-engineers-941f0897aa0
okr software 在 Taiwan Startup Stadium 台灣新創競技場 Facebook 的最佳貼文
#創業家聯盟 第二彈的講者名單來啦!
這次除了邀請到在國際上權威的人資顧問公司- 藝珂台灣之外,同時也邀請到菜蟲農食的創辦人以及TG3D的共同創辦人兼產品長來分享他們是如何管理有一定規模的團隊,把職員帶向快速成長之路!
🔺講者簡介:
1️⃣郭晏君 Viola Kuo | Adecco, Spring Professional
IT Team Manager, Information Technology & Software
The Adecco Group藝珂集團總部設於瑞士蘇黎世,是全球最大的國際性人力資源服務公司,名列《財富Fortune》全球前500大企業之一,於瑞士蘇黎士證券交易所股票公開上市。集團目前已有5,000多家分公司遍佈於世界60 個主要國家及地區市場,全職員工超過34,000名。每天有超過700,000名的約聘工作夥伴為100,000多公司提供最完善的人力資源服務。藝珂集團獲全球2020年最佳企業職場名單(World’s Best Workplaces list)排名第五。
2️⃣李昱德 |菜蟲農食股份有限公司 |執行長
菜蟲農食是一個提供餐廳直接向生產者採購蔬菜食材的平台。目前團隊共41人,有8名管理職,其中大多數是從員工培訓而成,為提升團隊績效,已於一年前導入OKR 績效管理工具,具備跨國頂尖企業多元之經驗,包括美商寶僑(Procter & Gamble)、丹麥商快桅(Maersk Line)、美商箭牌(Wrigley)等,為連續創業者,曾創辦Baby's Purest Organic Baby Foods。為策略以及營運專家,累績了七年國際產業與新創經驗。
3️⃣謝賀祥 Jac Hsieh|TG3D Studio Inc. |共同創辦人兼產品長
TG3D Studio 提供完整的 end-to-end 服裝產業數位化解決方案,讓客戶能將服裝產業最重要的元素 - 體型、布料、配件與服裝進行數位轉化。Jac 目前在 TG3D 負責全球產品策略規劃和設計,具有18年產品規劃經驗,包含創新產品開發、 APP 產品、雲端服務及硬體產品,曾任職於 Acer 負責 Acer Orbe Personal Cloud Service、Yahoo 負責 Shopping APP ,同時具有程式背景,撰寫過韌體程式整合系統及創新軟體,曾創辦過軟體公司活點子創意。
活動內容包含:
第一部分:人資管理秘辛大公開 Secrets to a Good HR System
從經驗老道的人資管理者角度,一一破解職員管理的迷思!從小團隊到大集團,從如何增加職員績效、加速擴張,到打造獎懲分明、良好明確的考核制度,幫助你打造最高效率的超強團隊。
第二部分:小組腦力激盪 Founder to Founder Brainstorming
根據實際案例,我們會以問題導向學習(Problem-based learning)方式分組,進行腦力激盪,從創業家彼此經驗得到回饋,挖掘最佳解答。
第三部分:績效評估與人力資源產值的分析 Performance Evaluation and Employee Output Analysis Discussion
邀請多家知名新創CEO來進行經驗分享。拆解人力與管理問題,根據不同體質的新創公司,擬定人員管理制度,刺激整個團隊更高效率的趨近目標。
13:30-14:00 入場
14:00-14:15 破冰活動
14:15-14:50 人資管理秘辛大公開
14:50-15:00 10分鐘中場休息
15:00- 16:00 小組腦力激盪
16:00-17:00 績效評估與人力資源產值的分析
17:00-17:30 大合照&交流時間
👉現在就報名!(名額有限,審核制)
https://www.accupass.com/event/2012040525561042791592
*配合防疫政策,活動期間必須全程配戴口罩,進入活動前會量額溫以及噴灑酒精消毒。
okr software 在 Shinee Wong 雪儿院长 Facebook 的最讚貼文
This is Vimigo - Google 如何利用OKR从40人到4000亿美金企业
我深深体会到马来西亚中企业不适合利用KPI, KPI 有一种把简单复杂化的感觉 , 而OKR is 把复杂简单化&目标化 。
蛮多人去询问这是什么系统,其实我们的底层设计的原理就是这个! 就是一个系统让员工和老板把话说清楚,目标定清晰,系统化同一目标向公司願景,使命出发。 大家把钱分对人, 奖励好的苹果,让坏苹果自己走 !
Vimigo - Vision- Mission - Goal
系统化同一目标向公司願景,使命出发
奖励好的苹果,让坏苹果自己走
马上点击链接查看
🔗 www.vimigoapp.com/wekah
Vimigo Software Preview — Puchong站
9月2号,1pm-4pm
9月10号, 1pm-4pm
9月24号, 1pm-4pm
🔗 www.vimigoapp.com/wekah
席位就快满了,希望到时见到你 !
文章来源:
https://elitesinsider.com/?p=2030
okr software 在 30 Best OKR Software of 2023: Reviewed & Compared 的相關結果
Peoplebox is the next-gen OKR & performance management platform designed for hyper-growth startups to drive better business growth through OKRs, ... ... <看更多>
okr software 在 OKR Software Reviews and Ratings 的相關結果
OKR Software is a tool which helps individuals, teams and broader organization set, track and measure their goals and objectives. ... <看更多>
okr software 在 11 Best OKR Software – Free & Paid Tools for Your 2023 ... 的相關結果
OKR software is designed to make it easy for teams and organizations to define, track and measure their OKRs. With an OKR program, users can ... ... <看更多>